---
sidebar_position: 4
toc_min_heading_level: 2
toc_max_heading_level: 2
---

# deleteFriend

## 功能介绍

:::info 说明

删除好友

:::

:::caution 注意

（1）由于是双向好友关系，此函数仅仅是删除自己的好友列表；  
（2）发起者所有终端会收到 OnFriendDeleted 回调；  
（3）删除好友并不会自动删除会话，如要删除会话，可以再调用删除会话的函数；

:::

<Tabs
groupId="sdks-language"
values={[
{ label: 'iOS', value: 'iOS', },
{ label: 'Android', value: 'Android', },
{ label: 'Flutter', value: 'Flutter', },
{ label: 'Uniapp', value: 'Uniapp', },
{ label: 'Web', value: 'Web', },
]
}>

<TabItem value="Flutter">

### 函数原型

```dart showLineNumbers
 Future<dynamic> deleteFriend({
    required String uid,
    String? operationID,
  })
```

### 输入参数

| 参数名称 | 参数类型 | 是否必填 | 描述    |
| -------- | -------- | -------- | ------- |
| uid      | String   | 是       | 用户 ID |

### 返回结果

| 参数名称 | 参数类型 | 描述                 |
| -------- | -------- | -------------------- |
| ~        | ~        | 无异常抛出则删除成功 |

### 代码示例

```dart showLineNumbers
   await OpenIM.iMManager.friendshipManager.deleteFriend(uid: 'uid');
    // todo
```

</TabItem>

<TabItem value="iOS">

### 函数原型

```swift showLineNumbers

- (void)deleteFriend:(NSString *)friendUserID
           onSuccess:(nullable OIMSuccessCallback)onSuccess
           onFailure:(nullable OIMFailureCallback)onFailure;

```

### 输入参数

| 参数名称     | 参数类型 | 是否必填 | 描述    |
| ------------ | -------- | -------- | ------- |
| friendUserID | NSString | 是       | 用户 ID |

### 返回结果

| 参数名称  | 参数类型                                               | 描述     |
| --------- | ------------------------------------------------------ | -------- |
| onSuccess | [OIMSuccessCallback](docs/sdks/Callback/onSuccess.mdx) | 成功返回 |
| onFailure | [OIMFailureCallback](docs/sdks/Callback/onError.mdx)   | 失败返回 |

### 代码示例

```swift showLineNumbers

[OIMManager.manager deleteFriend:@""
                       onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

```

</TabItem>

<TabItem value="Android">

### 参数详解

</TabItem>

<TabItem value="Web">

### 参数详解

</TabItem>

<TabItem value="Uniapp">

### 参数详解

| 参数名称    | 参数类型 | 是否必填 | 描述                                 |
| ----------- | -------- | -------- | ------------------------------------ | --- |
| operationID | string   | 是       | 唯一随机字符串，用于根据日志定位问题 |
| userID      | string   | 是       | IM 用户 userID                       |
| token       | string   | 是       | IM 用户 token                        |     |

### 返回模板

```
Promise<void>
```

### 代码示例

```js showLineNumbers
import IMSDK from '@openim-sdk/uniapp-polyfill';

await IMSDK.API.login(IMSDK.uuidv4(), userID, token);
```

</TabItem>

</Tabs>
